Frequently Asked Questions
General
What formats can I generate the outputs?
The default response is in JSON for all the APIs.
The output can only be converted to CSV on the GET Product Catalog API for both the All and price Experience.
To do this you will just need to add a āAcceptā key with the value of āapplication/csvā.
What does my response code mean?
400 - The request cannot be performed due to a malformed request syntax, and invalid request message, or an invalid request header.
401 - Invalid Credentials
403 - The required token to access the utility resources has not been specified.
404 - The specified resource was not found.
405 - An Invalid Method was specified for the resource.
406 - Not Acceptable.
415 - The specified content type in the request is not supported.
500 - The service is currently experiencing some technical issues.
503 - The service is currently experiencing some technical issues. Please send the original request later.
If you are still experiencing a code unexpected code, please email jbbusinessconnect@jbhifi.com.au for further assistance.
Are there rate limits or usage restrictions when using the APIs?
Yes, below are the rate limits and usage restrictions for all the APIs.
API endpoint | Requests | Time Interval (Per Seconds) |
---|---|---|
Token Sign | 5 | 90 |
POST Order | 5 | 90 |
GET Order | 90 | 90 |
GET Products by SKU | 300 | 300 |
GET Products | 100 | 300 |
Does my token expire and how can I know when?
The authorisation API creates a token that lasts 1 hour. If you try and call any of the APIs outside the 1 hour, itāll display error code 401. To fix this error you just need to reauthenticate the token by calling the Authorisation API again.
There is also an Expiry header in the token details, outline the expiry time.
This can be found inside the console under the GET authorisation API. Please note that the time displayed is in UTC time.
Do the APIs include webhooks?
No, the APIs donāt include webhooks. The only way to get pricing is currently only through the Product Catalog API.
Is there a list of recommended test SKUs and scenarios?
We want the onboarding process to be as easy as possible. If you need any SKUs or scenarios to test the APIs, please email jbbusinessconnect@jbhifi.com.au for the information.
How do I know the items are in or out of stock?
All APIs display an items availability
Product Catalog ā The All and individual Experience includes if the item is āin-stockā, ālimited-stockā, or āout-of-stockā.
The GET order status ā displays the status of the items on the order
The POST Submit order ā if the order doesnāt go into draft status, then the item is āin-stockā and allocated to a fulfilment location
Can I note a preferred store when submitting the order?
You can assign a preferred store when submitting your order.
If the item is in-stock at the location, it will be assiged.
If it isnāt the item will be assigned to the next location with stock available
Product Catalog API
What information can I retrieve using the Product Catalog API?
The Product Catalog API allows you to retrieve the products including the SKU, brand name, model number, short and long description, category, availability status, RRP and dimensions.
How often is the product prices updated?
Our product catalogues get updated every 3 hours with the most frequent change being pricing.
We recommend updating your catalogue data once per day at a minimum, please use this link for more information on the catalogue Product Catalogue Experience API (mulesoft.com).
Does the Product Catalog API have pagination?
Yes, you can adjust the products per page via the input header called ālimitā and adjust the page number by the input header called āoffsetā. Please use this link Product Catalogue Experience API (mulesoft.com) and go to the API Use section for more information.
What is the difference between All and Price?
The All-catalogue displays a complete set of information about each product.
The price-catalogue displays only the price and package dimensions for each product.
Can I see all products?
Yes, you can, all you need to do is remove the input header called āChannelā to display all available products.
Order Submission API
What information do I need to provide to submit an order?
The information youāll need is the order number, Item SKU code and quantity, Shipping details and billing details. Please refer to Orders Experience API (mulesoft.com) for the payload format.
Can I modify or cancel an order once it has been submitted?
Not through the API, you will need to reach out to your account manager immediately to amend or cancel the order before it gets completed.
Can I submit multiple orders at the same time?
No, you can only submit one order per API call, but it can be called multiple times in quick succession.
Is there an order quantity limit for a SKU?
If the quantity is over 100, the order will be rejected and not be generated in Salesforce. All orders below 100 will be accepted, but if the quantity is 5 or more the order will go into draft status for us to review as a bulk order.
Order Status API
What information can I retrieve using the GET Order Status API?
The GET Order Status API provides all the information for a certain order, including the recipientās details, order and item status, delivery consignment and tracking URL.
What does the order status mean?
DraftāÆ- The order has been started but not completed or submitted yet. It is in the process of being created or edited.
InitialāÆ- The order has been created and initialized in the system but hasn't progressed beyond the initial stages of processing.
Pending CreditāÆ- The order is awaiting verification or approval of credit before it can proceed further.
Awaiting ApprovalāÆ- The order is waiting for authorization or approval from a relevant authority or personnel before it can move forward.
Scheduled SubmissionāÆ- The order is set for submission later, typically more than 60 days from the creation date. This status allows for planning and scheduling of orders with extended delivery times.
Awaiting SubmissionāÆ- The scheduled submission date for the order has passed, and it is pending submission.
SubmittedāÆ- The order has been successfully submitted for fulfilment.
Order ReceivedāÆ- The order has been pending fulfilment.
In ProgressāÆ- The order is currently being processed and fulfilled by JB Business.
CompletedāÆ- The order has been fulfilled, processed, and delivered to the customer
CancelledāÆ- The order has been cancelled by the customer or by JB Business. It will not proceed any further and order is considered void
Can I get order status for multiple orders in one request?
No, call one order at a time, but it can be called multiple times in quick succession.